001    /*
002     * Copyright 2004-2005 Stephen J. McConnell.
003     *
004     * Licensed  under the  Apache License,  Version 2.0  (the "License");
005     * you may not use  this file  except in  compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *   http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed  under the  License is distributed on an "AS IS" BASIS,
012     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.transit.artifact;
020    
021    import net.dpml.transit.Artifact;
022    
023    /**
024     * Exception to indicate that the Artifact already exists in the cache and
025     * can therefor not be written to.
026     *
027     * @author <a href="http://www.dpml.net">Digital Product Meta Library</a>
028     * @version 1.0.2
029     */
030    public class ArtifactAlreadyExistsException extends ArtifactException
031    {
032       /**
033        * Serial version identifier.
034        */
035        static final long serialVersionUID = 1L;
036    
037        // ------------------------------------------------------------------------
038        // state
039        // ------------------------------------------------------------------------
040    
041       /**
042        * The artifact that we tried to write to.
043        */
044        private final Artifact m_artifact;
045    
046        // ------------------------------------------------------------------------
047        // constructor
048        // ------------------------------------------------------------------------
049    
050        /**
051         * Construct a new <code>ArtifactAlreadyExistsException</code> instance.
052         *
053         * @param message the exception message
054         * @param artifact the subject artifact
055         */
056        public ArtifactAlreadyExistsException( final String message, final Artifact artifact )
057        {
058            super( message );
059            m_artifact = artifact;
060        }
061    
062        /**
063         * Returns the Artifact that were attempted to be written to.
064         * @return the subject artifact
065         */
066        public Artifact getArtifact()
067        {
068            return m_artifact;
069        }
070    }
071